Skip to content

refactor: split catalog-doc-check into agent + skill#31

Merged
leanderdruwel-skyline merged 13 commits into
mainfrom
refactor/catalog-doc-skill-split
May 20, 2026
Merged

refactor: split catalog-doc-check into agent + skill#31
leanderdruwel-skyline merged 13 commits into
mainfrom
refactor/catalog-doc-skill-split

Conversation

@leanderdruwel-skyline
Copy link
Copy Markdown
Collaborator

Summary

Splits agents/catalog-doc-check.agent.md into an agent (behavioral logic) + skill (domain knowledge) by adding a new skills/ folder.

Why

  • The skill (skills/catalog-doc/SKILL.md) is reusable: a developer-facing agent in .github-private can reference the same catalog documentation rules without duplicating them
  • The agent stays focused on what to do (procedure, activation, output, constraints), while the skill owns what the rules are
  • The workflow now also explicitly imports shared/global-instructions.md, which was previously referenced as a markdown link (not included in the prompt)

Changes

File Change
skills/catalog-doc/SKILL.md New — all validation rules, severity definitions, include/avoid table, common issues table
agents/catalog-doc-check.agent.md Updated — removed inline rules, added explicit bridge pointing to the skill as authoritative source
workflows/catalog-doc-check.md Updated — now imports global-instructions, catalog-doc skill, and catalog-doc-check agent in order

Content split rationale

Moved to skill:

  • Severity level definitions
  • All per-section validation rules (README existence, About, Key Features, Use Cases, Prerequisites, Technical Reference, Visuals, Contact/Support)
  • Content to Include and Avoid table
  • Common Issues and Solutions table

Stays in agent:

  • Activation Guard (runtime event filtering)
  • Scope (how to discover CatalogInformation/README.md)
  • Validation Procedure (the ordered steps)
  • Role and Constraints (read-only, no direct edits)
  • Output Format (issue/PR creation logic)

⚠️ Breaking change for existing consumers

The agent.md no longer contains inline validation rules. Any repo that has compiled a lock.yml using the old catalog-doc-check.md workflow and does a runtime-import of only agents/catalog-doc-check.agent.md will be missing the rules at runtime.

Required action for consumers: Re-install and recompile workflows/catalog-doc-check.md to pick up the new multi-import structure:

gh aw install SkylineCommunications/_ReusableAgenticWorkflows/workflows/catalog-doc-check.md
gh aw compile

@leanderdruwel-skyline
Copy link
Copy Markdown
Collaborator Author

@copilot resolve the merge conflicts in this pull request

Copy link
Copy Markdown
Contributor

Copilot AI commented May 20, 2026

@copilot resolve the merge conflicts in this pull request

Resolved in 8beb7f4. I merged origin/main, kept the agent+skill split intact in agents/catalog-doc-check.agent.md, and finalized the merge commit so the PR should no longer show conflicts.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/github/gh-aw/releases/latest
    • Triggering command: /usr/bin/gh gh extension install github/gh-aw (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@leanderdruwel-skyline
Copy link
Copy Markdown
Collaborator Author

I notice that readme files are involved in, which is unexpected.
8beb7f4

I would expect that only the catalog check agent and skill are impacted
@copilot ?

Copy link
Copy Markdown
Contributor

Copilot AI commented May 20, 2026

I notice that readme files are involved in, which is unexpected.
8beb7f4

...

You're right to call that out. Those README-related files were pulled in only because 8beb7f4 is a merge commit from main; GitHub shows the main-branch additions in that commit view. I checked the actual diff against main, and the PR itself is only changing agents/catalog-doc-check.agent.md, skills/catalog-documentation-standards.md, and workflows/catalog-doc-check.md.

@leanderdruwel-skyline leanderdruwel-skyline merged commit f651f04 into main May 20, 2026
1 check passed
@leanderdruwel-skyline leanderdruwel-skyline deleted the refactor/catalog-doc-skill-split branch May 20, 2026 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants